/*
 * Copyright 2011 Clean GWT
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.cleangwt.bootstrap.client.ui;

import com.google.gwt.dom.client.Element;

/**
 * The scrollspy configurator.
 * 
 * @author Jess
 * @version 1.0
 * @since 1.0
 * @see http://getbootstrap.com/javascript/#scrollspy
 */
public class Scrollspy {

  /**
   * Sets the element to be a scrollspy-scroller.
   * 
   * @param e the element to be a scrollspy-scroller
   */
  public static void as(Element e) {
    e.setAttribute(DataModel.DATA_SPY, DataModel.SPY_SCROLL);
  }

  /**
   * Refreshes scrollspy for the given scroller element.
   * 
   * @param e the scroller element
   */
  public static native void refresh(Element e) /*-{
                                               $wnd.jQuery(e).scrollspy('refresh');
                                               }-*/;

  /**
   * Sets the target and offset for the given scroller element.
   * 
   * @param e the scroller
   * @param target the navigator
   * @param offset the pixels to offset from top when calculating position of scroll
   */
  public static native void configure(Element e, String target, int offset) /*-{
                                                                            $wnd.jQuery(e).scrollspy({
                                                                            target: target,
                                                                            offset: offset
                                                                            });
                                                                            }-*/;

}
